/*
 * $Id: l3.h,v 1.3 Broadcom SDK $
 * $Copyright: Copyright 2011 Broadcom Corporation.
 * This program is the proprietary software of Broadcom Corporation
 * and/or its licensors, and may only be used, duplicated, modified
 * or distributed pursuant to the terms and conditions of a separate,
 * written license agreement executed between you and Broadcom
 * (an "Authorized License").  Except as set forth in an Authorized
 * License, Broadcom grants no license (express or implied), right
 * to use, or waiver of any kind with respect to the Software, and
 * Broadcom expressly reserves all rights in and to the Software
 * and all intellectual property rights therein.  IF YOU HAVE
 * NO AUTHORIZED LICENSE, THEN YOU HAVE NO RIGHT TO USE THIS SOFTWARE
 * IN ANY WAY, AND SHOULD IMMEDIATELY NOTIFY BROADCOM AND DISCONTINUE
 * ALL USE OF THE SOFTWARE.  
 *  
 * Except as expressly set forth in the Authorized License,
 *  
 * 1.     This program, including its structure, sequence and organization,
 * constitutes the valuable trade secrets of Broadcom, and you shall use
 * all reasonable efforts to protect the confidentiality thereof,
 * and to use this information only in connection with your use of
 * Broadcom integrated circuit products.
 *  
 * 2.     TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS
 * PROVIDED "AS IS" AND WITH ALL FAULTS AND BROADCOM MAKES NO PROMISES,
 * REPRESENTATIONS OR WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY,
 * OR OTHERWISE, WITH RESPECT TO THE SOFTWARE.  BROADCOM SPECIFICALLY
 * DISCLAIMS ANY AND ALL IMPLIED WARRANTIES OF TITLE, MERCHANTABILITY,
 * NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, LACK OF VIRUSES,
 * ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION OR
 * CORRESPONDENCE TO DESCRIPTION. YOU ASSUME THE ENTIRE RISK ARISING
 * OUT OF USE OR PERFORMANCE OF THE SOFTWARE.
 * 
 * 3.     TO THE MAXIMUM EXTENT PERMITTED BY LAW, IN NO EVENT SHALL
 * BROADCOM OR ITS LICENSORS BE LIABLE FOR (i) CONSEQUENTIAL,
 * INCIDENTAL, SPECIAL, INDIRECT, OR EXEMPLARY DAMAGES WHATSOEVER
 * ARISING OUT OF OR IN ANY WAY RELATING TO YOUR USE OF OR INABILITY
 * TO USE THE SOFTWARE EVEN IF BROADCOM HAS BEEN ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES; OR (ii) ANY AMOUNT IN EXCESS OF
 * THE AMOUNT ACTUALLY PAID FOR THE SOFTWARE ITSELF OR USD 1.00,
 * WHICHEVER IS GREATER. THESE LIMITATIONS SHALL APPLY NOTWITHSTANDING
 * ANY FAILURE OF ESSENTIAL PURPOSE OF ANY LIMITED REMEDY.$
 *
 * This file defines L3 constants 
 *
 * Its contents are not used directly by applications; it is used only
 * by header files of parent APIs which need to share  L3 constants.
 */

#ifndef _SHR_L3_H
#define _SHR_L3_H

/* 
 *  Reserved VRF values 
 */
#define _SHR_L3_VRF_OVERRIDE  (-1) /* Matches before vrf specific entries.*/
#define _SHR_L3_VRF_GLOBAL    (-2) /* Matches after vrf specific entries. */
#define _SHR_L3_VRF_DEFAULT    (0) /* Default vrf id.                     */

#define _SHR_L3_IP6_ADDRLEN       (16)  /* IPv6 address length in bytes.      */
#define _SHR_L3_IP6_ADDR_WORD_LEN (4)  /* IPv6 address length in bytes.      */
#define _SHR_L3_IP6_MAX_NETLEN    ((_SHR_L3_IP6_ADDRLEN) * (8))
#define _SHR_L3_IP_ADDRLEN     (4)   /* IPv4 address length in bytes.      */
#define _SHR_L3_IP_MAX_NETLEN  ((_SHR_L3_IP_ADDRLEN) * (8))

typedef uint32  _shr_ip_addr_t;                          /* IP Address   */
typedef uint8   _shr_ip6_addr_t[_SHR_L3_IP6_ADDRLEN];    /* IPv6 Address */

extern int _shr_ip6_mask_create(uint8 *ip6, int len);
extern int _shr_ip6_mask_length(uint8 *mask);
extern uint32 _shr_ip_mask_create(int len);
extern int _shr_ip_mask_length(uint32 mask);

#endif	/* !_SHR_L3_H */
